<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: util/process_credentials.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a762a7cb84c76c9561dbc78c61068184.html">util</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">process_credentials.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="process__credentials_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#ifndef _GNU_SOURCE</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#  define _GNU_SOURCE </span><span class="comment">// Needed at least to get access to `struct ::ucred` (Linux).</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;<a class="code" href="util__fwd_8hpp.html">ipc/util/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &quot;<a class="code" href="process__credentials__fwd_8hpp.html">ipc/util/process_credentials_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1util.html">ipc::util</a></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>{</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"></span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">/**</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * A process&#39;s credentials (PID, UID, GID as of this writing).</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> *</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * @see Opt_peer_process_credentials, a sub-class.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> */</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Process__credentials.html">   38</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1util_1_1Process__credentials.html">Process_credentials</a></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>{</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"></span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment">  /// Default ctor: each value is initialized to zero or equivalent.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a3840b767894abdd17cf9a7b5b2dfbf3c">Process_credentials</a>();</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"></span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment">   * Ctor that sets the values explicitly.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment">   * @param process_id_init</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment">   *        See process_id().</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">   * @param user_id_init</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">   *        See user_id().</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">   * @param group_id_init</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">   *        See group_id().</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">   */</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a3840b767894abdd17cf9a7b5b2dfbf3c">Process_credentials</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#a0c44028a45451ebf21f6af8e806b2682">process_id_t</a> process_id_init, <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6435c1b48ec8684c24ca406d1d17208e">user_id_t</a> user_id_init, <a class="code hl_typedef" href="namespaceipc_1_1util.html#a3f7d069ce0d23f73153da2e2559dc3d3">group_id_t</a> group_id_init);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"></span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment">   * Boring copy ctor.</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">   *        Source object.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">   */</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Process__credentials.html#a3c7e32527927afdf2d7b46e2aa9a82b6">   62</a></span>  <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a3c7e32527927afdf2d7b46e2aa9a82b6">Process_credentials</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Process__credentials.html">Process_credentials</a>&amp; src);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"></span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">   * Boring copy assignment.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">   *        Source object.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">   */</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Process__credentials.html#a8f507637515a11b2f7e50959a8a39ce2">   72</a></span>  <a class="code hl_class" href="classipc_1_1util_1_1Process__credentials.html">Process_credentials</a>&amp; <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a8f507637515a11b2f7e50959a8a39ce2">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Process__credentials.html">Process_credentials</a>&amp; src);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"></span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   * The process ID (PID).</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">   */</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>  <a class="code hl_typedef" href="namespaceipc_1_1util.html#a0c44028a45451ebf21f6af8e806b2682">process_id_t</a> <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a181288d97adcadedf187d08c71045854">process_id</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"></span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">   * The user ID (UID).</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   */</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>  <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6435c1b48ec8684c24ca406d1d17208e">user_id_t</a> <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#ac1fb8e7a5663735405ca0c0bc29163c5">user_id</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"></span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   * The group user ID (GID).</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   */</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>  <a class="code hl_typedef" href="namespaceipc_1_1util.html#a3f7d069ce0d23f73153da2e2559dc3d3">group_id_t</a> <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#ae54faa2974b966d31678fd51b7200514">group_id</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"></span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">   * Obtains, from the OS, information as to the binary name via which process process_id() was started, per its</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">   * command line, namely `argv[0]`.  In simplified terms this is the executable of `*this` process; however</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   * there are important properties to consider about this information:</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">   *   - The process must be currently executing.  If it is not, a no-such-file error is emitted.</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   *   - The executable name is as-it-appeared on the command line; e.g., it might be a relative and/or</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">   *     un-normalized and/or a symlink.  It is only the normalized, absolute path if that is how it was invoked.</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">   *   - It is possible (not common but not non-existent either) for a process to change its own command line</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   *     upon execution; in this case there&#39;s almost no limit to what string might result.</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   *     Note!  Even an empty returned string is possible; and this is not emitted as an error.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   *</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   * Because of these facts we feel it is, informally, best to use this information for one of these use cases:</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   *   - logging;</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">   *   - verification against an expected value, especially when safety-checking against an expected policy</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">   *     (e.g., against session::App::m_exec_path) -- namely that, say, the given process was (1) an instance</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">   *     of a specific application and (2) was invoked via its normalized, absolute path.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">   *</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">   * For these cases it should be reasonable to use.</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">   *</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">   * ### Implementation/rationale for it ###</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">   * (Normally we omit impl details in public doc headers, but in this case the utility is low-level, and it may</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   * benefit you to know it.)</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   *</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   * This builds in Linux only; it reads /proc/(pid)/cmdline (if it exists) and obtains the first NUL-terminated</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   * entry there.  This is `argv[0]`.  `argv` space may be overwritten by the process, so it could be something</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">   * other than the original invocation.  Ignoring that, it&#39;ll be whatever the command line included; could be</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment">   * absolute or not, normalized or not, the symlink or not... and so on.  The tool `ps` uses the same technique.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">   *</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">   * One technique was considered: read Linux&#39;s /proc/(pid)/exe symlink which points to the absolute, normalized</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">   * executable path actually invoked.  That would have been perfect; however it appears to require</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   * admin privileges on our part, and we do not want to require this.  On balance, since the original use case</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">   * prompting this feature (session::App::m_exec_path verification) is acceptably served by the less-demanding</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">   * /proc/.../cmdline method, we chose that.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   *</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   *        some system error code; but most likely no-such-file error of some kind, indicating the process</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   *        is not executing (any longer?).</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">   * @return The first entry -- the executable -- according to the process&#39;s command line (see above),</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">   *         if no #Error_code is emitted.  If one *is* emitted, without an exception (`err_code` not null),</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">   *         empty string.  Caution: If error is *not* emitted, returned value *might* still be empty,</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">   *         if the process overrode its own command line (see above).</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment">   */</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>  std::string <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#ae4f156cfdfe0c8c5702890e5c1a37cdf">process_invoked_as</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"></span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">   * Obtains the calling process&#39;s process_id().  This value will never change.</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">   */</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>  <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a0c44028a45451ebf21f6af8e806b2682">process_id_t</a> <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a18c901aeeed11c91afcc6379260f02a5">own_process_id</a>();</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"></span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">   * Obtains the calling process&#39;s effective user_id().  This value can be changed via OS calls.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">   */</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>  <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6435c1b48ec8684c24ca406d1d17208e">user_id_t</a> <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a9a14d2788f0aaf91042206d5f6e5cabd">own_user_id</a>();</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"></span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">   * Obtains the calling process&#39;s effective group_id().  This value can be changed via OS calls.</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">   */</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>  <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a3f7d069ce0d23f73153da2e2559dc3d3">group_id_t</a> <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a9c4074f11192a1193afb019d04753cd2">own_group_id</a>();</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"></span> </div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment">   * Constructs and returns Process_credentials containing values pertaining to the calling process at this</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">   * time.  Note that certain values therein may become incorrect over time (see own_user_id(), own_group_id()).</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">   *</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">   * @return `Process_credentials(own_process_id(), own_user_id(), own_group_id())`.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">   */</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>  <span class="keyword">static</span> <a class="code hl_class" href="classipc_1_1util_1_1Process__credentials.html">Process_credentials</a> <a class="code hl_function" href="classipc_1_1util_1_1Process__credentials.html#a573d6de2f257144562fd55e0772991f1">own_process_credentials</a>();</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"></span> </div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment">  /// The raw data.  By using Linux `ucred` directly, we can reuse this as base for Opt_peer_process_credentials.</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"><a class="line" href="classipc_1_1util_1_1Process__credentials.html#a5e9f0979d5b61f4d4557d1e338871b2f">  167</a></span><span class="comment"></span>  ::ucred <a class="code hl_variable" href="classipc_1_1util_1_1Process__credentials.html#a5e9f0979d5b61f4d4557d1e338871b2f">m_val</a>;</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>}; <span class="comment">// class Process_credentials</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span> </div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span>} <span class="comment">// namespace ipc::util</span></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html">ipc::util::Process_credentials</a></div><div class="ttdoc">A process's credentials (PID, UID, GID as of this writing).</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8hpp_source.html#l00038">process_credentials.hpp:39</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a181288d97adcadedf187d08c71045854"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a181288d97adcadedf187d08c71045854">ipc::util::Process_credentials::process_id</a></div><div class="ttdeci">process_id_t process_id() const</div><div class="ttdoc">The process ID (PID).</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00047">process_credentials.cpp:47</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a18c901aeeed11c91afcc6379260f02a5"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a18c901aeeed11c91afcc6379260f02a5">ipc::util::Process_credentials::own_process_id</a></div><div class="ttdeci">static process_id_t own_process_id()</div><div class="ttdoc">Obtains the calling process's process_id().</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00126">process_credentials.cpp:126</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a3840b767894abdd17cf9a7b5b2dfbf3c"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a3840b767894abdd17cf9a7b5b2dfbf3c">ipc::util::Process_credentials::Process_credentials</a></div><div class="ttdeci">Process_credentials()</div><div class="ttdoc">Default ctor: each value is initialized to zero or equivalent.</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00028">process_credentials.cpp:28</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a3c7e32527927afdf2d7b46e2aa9a82b6"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a3c7e32527927afdf2d7b46e2aa9a82b6">ipc::util::Process_credentials::Process_credentials</a></div><div class="ttdeci">Process_credentials(const Process_credentials &amp;src)</div><div class="ttdoc">Boring copy ctor.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a573d6de2f257144562fd55e0772991f1"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a573d6de2f257144562fd55e0772991f1">ipc::util::Process_credentials::own_process_credentials</a></div><div class="ttdeci">static Process_credentials own_process_credentials()</div><div class="ttdoc">Constructs and returns Process_credentials containing values pertaining to the calling process at thi...</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00141">process_credentials.cpp:141</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a5e9f0979d5b61f4d4557d1e338871b2f"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a5e9f0979d5b61f4d4557d1e338871b2f">ipc::util::Process_credentials::m_val</a></div><div class="ttdeci">::ucred m_val</div><div class="ttdoc">The raw data. By using Linux ucred directly, we can reuse this as base for Opt_peer_process_credentia...</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8hpp_source.html#l00167">process_credentials.hpp:167</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a8f507637515a11b2f7e50959a8a39ce2"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a8f507637515a11b2f7e50959a8a39ce2">ipc::util::Process_credentials::operator=</a></div><div class="ttdeci">Process_credentials &amp; operator=(const Process_credentials &amp;src)</div><div class="ttdoc">Boring copy assignment.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a9a14d2788f0aaf91042206d5f6e5cabd"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a9a14d2788f0aaf91042206d5f6e5cabd">ipc::util::Process_credentials::own_user_id</a></div><div class="ttdeci">static user_id_t own_user_id()</div><div class="ttdoc">Obtains the calling process's effective user_id().</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00131">process_credentials.cpp:131</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_a9c4074f11192a1193afb019d04753cd2"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#a9c4074f11192a1193afb019d04753cd2">ipc::util::Process_credentials::own_group_id</a></div><div class="ttdeci">static group_id_t own_group_id()</div><div class="ttdoc">Obtains the calling process's effective group_id().</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00136">process_credentials.cpp:136</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_ac1fb8e7a5663735405ca0c0bc29163c5"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#ac1fb8e7a5663735405ca0c0bc29163c5">ipc::util::Process_credentials::user_id</a></div><div class="ttdeci">user_id_t user_id() const</div><div class="ttdoc">The user ID (UID).</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00052">process_credentials.cpp:52</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_ae4f156cfdfe0c8c5702890e5c1a37cdf"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#ae4f156cfdfe0c8c5702890e5c1a37cdf">ipc::util::Process_credentials::process_invoked_as</a></div><div class="ttdeci">std::string process_invoked_as(Error_code *err_code=0) const</div><div class="ttdoc">Obtains, from the OS, information as to the binary name via which process process_id() was started,...</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00062">process_credentials.cpp:62</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html_ae54faa2974b966d31678fd51b7200514"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html#ae54faa2974b966d31678fd51b7200514">ipc::util::Process_credentials::group_id</a></div><div class="ttdeci">group_id_t group_id() const</div><div class="ttdoc">The group user ID (GID).</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8cpp_source.html#l00057">process_credentials.cpp:57</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html"><div class="ttname"><a href="namespaceipc_1_1util.html">ipc::util</a></div><div class="ttdoc">Flow-IPC module containing miscellaneous general-use facilities that ubiquitously used by ~all Flow-I...</div><div class="ttdef"><b>Definition:</b> <a href="default__init__allocator_8hpp_source.html#l00023">default_init_allocator.hpp:24</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a0c44028a45451ebf21f6af8e806b2682"><div class="ttname"><a href="namespaceipc_1_1util.html#a0c44028a45451ebf21f6af8e806b2682">ipc::util::process_id_t</a></div><div class="ttdeci">::pid_t process_id_t</div><div class="ttdoc">Syntactic-sugary type for POSIX process ID (integer).</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00143">util_fwd.hpp:143</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a3f7d069ce0d23f73153da2e2559dc3d3"><div class="ttname"><a href="namespaceipc_1_1util.html#a3f7d069ce0d23f73153da2e2559dc3d3">ipc::util::group_id_t</a></div><div class="ttdeci">::gid_t group_id_t</div><div class="ttdoc">Syntactic-sugary type for POSIX group ID (integer).</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00149">util_fwd.hpp:149</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6435c1b48ec8684c24ca406d1d17208e"><div class="ttname"><a href="namespaceipc_1_1util.html#a6435c1b48ec8684c24ca406d1d17208e">ipc::util::user_id_t</a></div><div class="ttdeci">::uid_t user_id_t</div><div class="ttdoc">Syntactic-sugary type for POSIX user ID (integer).</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00146">util_fwd.hpp:146</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="aprocess__credentials__fwd_8hpp_html"><div class="ttname"><a href="process__credentials__fwd_8hpp.html">process_credentials_fwd.hpp</a></div></div>
<div class="ttc" id="autil__fwd_8hpp_html"><div class="ttname"><a href="util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
